home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Vk / VkMenuBar.z / VkMenuBar
Encoding:
Text File  |  2002-10-03  |  9.9 KB  |  265 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkMMMMeeeennnnuuuuBBBBaaaarrrr((((3333xxxx))))                                                    VVVVkkkkMMMMeeeennnnuuuuBBBBaaaarrrr((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkMenuBar - A ViewKit Menu Bar
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkMenu : VkMenuItem : VkComponent : VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkMenuBar.h>
  16.  
  17.  
  18. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  19.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  20.            VkMenuBar(Boolean showHelpPane = TRUE);
  21.            VkMenuBar(const char *name,
  22.                      Boolean     showHelpPane = TRUE);
  23.            VkMenuBar(VkMenuDesc *desc,
  24.                      XtPointer   defaultCientData= NULL,
  25.                      Boolean     showHelpPane = TRUE);
  26.            VkMenuBar(const char *name,
  27.                      VkMenuDesc *name,
  28.                      XtPointer   defaultCientData= NULL,
  29.                      Boolean     showHelpPane = TRUE);
  30.            virtual ~VkMenuBar();
  31.  
  32.  
  33.    AAAAcccccccceeeessssssss FFFFuuuunnnnccccttttiiiioooonnnnssss
  34.            VkSubMenu  *helpPane() const {return _helpPane;}
  35.            virtual VkMenuItemType menuType();
  36.            virtual const char* className();
  37.            void showHelpPane(Boolean showit);
  38.  
  39.  
  40. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  41.      The VkMenuBar class provides a menu bar designed to work with the
  42.      VkWindow class. By default, instances of VkMenuBar automatically create a
  43.      help pane that interfaces to the ViewKit help system. Other panes may be
  44.      added using the interface supported by VkMenu.
  45.  
  46. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  47.    VVVVkkkkMMMMeeeennnnuuuuBBBBaaaarrrr
  48.            VkMenuBar(Boolean showHelpPane = TRUE);
  49.  
  50.            VkMenuBar(const char *name,
  51.                      Boolean     showHelpPane = TRUE);
  52.             VkMenuBar(VkMenuDesc *desc,
  53.                      XtPointer   defaultCientData= NULL,
  54.                      Boolean     showHelpPane = TRUE);
  55.  
  56.            VkMenuBar(const char *name,
  57.                     VkMenuDesc *desc,
  58.                      XtPointer   defaultCientData= NULL,
  59.                      Boolean     showHelpPane = TRUE);
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkMMMMeeeennnnuuuuBBBBaaaarrrr((((3333xxxx))))                                                    VVVVkkkkMMMMeeeennnnuuuuBBBBaaaarrrr((((3333xxxx))))
  71.  
  72.  
  73.  
  74.      The VkMenuBar constructor initializes an instance of VkMenuBar. To work
  75.      with SGI's color schemes (See Schemes(3X)), the name of this instance
  76.      should be "menuBar". If a form that does not take a name argument is
  77.      used, the name "menuBar" will be used automatically. Another name can
  78.      also be specified, but schemes will not work correctly. That last
  79.      argument to each version of this constructor specifies whether or not a
  80.      help menu pane will be added. The default is to install a help pane.
  81.  
  82.      Two forms of this constructor support a _d_e_f_a_u_l_t_C_l_i_e_n_t_D_a_t_a argument. If
  83.      provided, any menu item that does not provide a client data argument will
  84.      use this argument instead. This allows menus to be specified statically,
  85.      while still allowing an instance pointer to be used with callbacks. For
  86.      example, the following code segment creates a menubar with a menu pane.
  87.      All callbacks associated with the menu will be passed the instance
  88.      pointer of the object that creates the menu bar object.
  89.  
  90.  
  91.            class Sample: public VkWindow {
  92.  
  93.             private:
  94.  
  95.               static void oneCallback( Widget,
  96.                                        XtPointer,
  97.                                        XtPointer);
  98.               static void twoCallback( Widget,
  99.                                        XtPointer ,
  100.                                        XtPointer);
  101.               static void cutCallback( Widget,
  102.                                        XtPointer,
  103.                                        XtPointer);
  104.               static void pasteCallback( Widget,
  105.                                          XtPointer ,
  106.                                          XtPointer);
  107.  
  108.               static VkMenuDesc applicationPane[];
  109.               static VkMenuDesc editPane[];
  110.               static VkMenuDesc menu[];
  111.  
  112.             protected:
  113.  
  114.             public:
  115.  
  116.               Sample(const char *name) : VkWindow(name)
  117.  
  118.               // Other members
  119.            };
  120.  
  121.             SampleWindow::SampleWindow(char *name) : VkWindow(name)
  122.             {
  123.                  setMenuBar(new VkMenuBar(menu, (XtPointer) this));
  124.  
  125.                  // Other actions
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkMMMMeeeennnnuuuuBBBBaaaarrrr((((3333xxxx))))                                                    VVVVkkkkMMMMeeeennnnuuuuBBBBaaaarrrr((((3333xxxx))))
  137.  
  138.  
  139.  
  140.             }
  141.  
  142.  
  143.  
  144.    ~~~~VVVVkkkkMMMMeeeennnnuuuuBBBBaaaarrrr
  145.            virtual ~VkMenuBar();
  146.  
  147.  
  148.           The VkMenuBar destructor is empty.
  149.  
  150.    hhhheeeellllppppPPPPaaaannnneeee
  151.            VkSubMenu  *helpPane();
  152.  
  153.  
  154.           Returns the VkSubMenu item used as the help pane.
  155.  
  156.    mmmmeeeennnnuuuuTTTTyyyyppppeeee
  157.            virtual VkMenuItemType menuType();
  158.  
  159.  
  160.           The menuType of this class is BAR.
  161.  
  162.    ccccllllaaaassssssssNNNNaaaammmmeeee
  163.            virtual const char* className();
  164.  
  165.  
  166.           The class name of this class is "VkMenuBar".
  167.  
  168.    sssshhhhoooowwwwHHHHeeeellllppppPPPPaaaannnneeee
  169.            void showHelpPane(Boolean showit = TRUE);
  170.  
  171.  
  172.           Controls whether the Help pane is visible or not. The default is to
  173.           show the Help menu pane.
  174.  
  175. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  176.      See VkMenu(3X) for examples
  177.  
  178. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  179.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkMMMMeeeennnnuuuu
  180.           isContainer(),    findParent(), addAction(),  addActionWidget(),
  181.           addConfirmFirstAction(),  addSeparator(), addLabel(),  addToggle(),
  182.           addToggle(),  add(),   addSubmenu(),  addRadioSubmenu(),
  183.           registerSubmenu(),  findNamedItem(),  removeItem(),  activateItem(),
  184.           deactivateItem(), replace(),  getItemPosition(),  getItemPosition(),
  185.           getItemPosition(),  operator[](), numItems(),  _contents,  _nItems,
  186.           _maxItems,
  187.  
  188.  
  189.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkMMMMeeeennnnuuuuIIIItttteeeemmmm
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. VVVVkkkkMMMMeeeennnnuuuuBBBBaaaarrrr((((3333xxxx))))                                                    VVVVkkkkMMMMeeeennnnuuuuBBBBaaaarrrr((((3333xxxx))))
  203.  
  204.  
  205.  
  206.           show(), hide(), manageAll(), setLabel(), setPosition(), activate(),
  207.           deactivate(), remove(), show(), _position, _isBuilt, _sensitive,
  208.           _parentMenu, _label, _isHidden, _unmanagedWidgets,
  209.           _numUnmanagedWidgets,
  210.  
  211.  
  212.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  213.           installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
  214.           setDefaultResources(), getResources(), manage(), unmanage(),
  215.           baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback
  216.  
  217.  
  218.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  219.           callCallbacks(), addCallback(), removeCallback(),
  220.           removeAllCallbacks()
  221.  
  222.  
  223. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  224.      HelpFacilityMotif, VkApp, VkDialogManager, VkMenu, VkMenuItem, VkSubMenu
  225.  
  226. KKKKNNNNOOOOWWWWNNNN CCCCLLLLAAAASSSSSSSSEEEESSSS TTTTHHHHAAAATTTT UUUUSSSSEEEE TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  227.      VkWindow
  228.  
  229. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  230.      VkMenu, VkMenuItem, VkComponent, HelpFacilityMotif, VkApp,
  231.      VkDialogManager, VkSubMenu, VkWindow
  232.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  233.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  234.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  235.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.